ServerData
The data source server object and its settings.
API Section: Objects
Type: Object
Properties
Name |
Description |
Required |
Type |
Format |
---|---|---|---|---|
isPaused |
Flag to set the state of the datasource to either be queryable or not |
- |
boolean |
|
instanceName |
The instance name of the data source (if relevant) |
- |
string |
|
overlayPyramidSecurity |
Boolean flag if the data source will use Pyramid's security and metadata overlays |
- |
boolean |
|
useGlobalAccount |
Boolean to flag if the global account should be sued for connecting. Default:false |
- |
boolean |
|
serverName |
The data source server's caption or name |
Y |
string |
|
description |
The data source server's description |
- |
string |
|
securedByUser |
Boolean flag if the data source will be secured by each end-user |
- |
boolean |
|
userName |
User Id needed for connection |
- |
string |
|
writeCapable |
Read=0, Write=1, Default:Read |
- |
integer |
int32 |
password |
User password need for connection |
- |
string |
|
defaultDatabaseName |
The default database to be used with the data source |
- |
string |
|
serverAuthenticationMethod |
Authentication method details when securing the connection. |
- | ||
port |
The data source server's port number |
- |
integer |
int32 |
pulseClient |
The Pulse client ID if used with the data source |
- |
string |
|
serverType |
The data source server's type enumeration |
Y |
||
tenantId |
The tenant ID that the data source will be attached to |
- |
string |
|
modifiedDate |
The last date that the server has been modified. ignored in server creation |
- |
integer |
Api2: int64 - epoch time in milliseconds, Api3: String according to iso8601 |
serverIp |
The data source server's IP address or FQDN |
Y |
string |
|
id |
The data source's system ID |
- |
string |
|
additionalServerProperties |
Additional connection properties and settings for the data source |
- | ||
displayFolder |
The data source server's display folder |
- |
string |
|
optionalParameters |
Optional parameters for data source connection |
- |
string |
*Required elements are only used for API parameters